Update from code changes: document editor version history - #6872
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Update from code changes updated this PR. Updated Chinese editor page description for SEO compliance Source PRs
|
|
Update from code changes updated this PR. Added paragraph breaks to improve version history readability across four localized guides Source PRs
|
|
Update from code changes updated this PR. Refined restore-scope wording across four localized editor pages Source PRs
|
|
Update from code changes updated this PR. Added no new documentation; completed a best-practices audit Source PRs
|
|
Update from code changes updated this PR. Added no new documentation changes Source PRs
|
|
Update from code changes updated this PR. Added no documentation changes Source PRs
|
Summary
Documents the editor version history and restore features introduced in mintlify/mint#9783, mintlify/mint#9787, and mintlify/server#7263.
Changes
Medium Risk
Documentation-only changes to MDX guides. The documented restore action replaces current page content and can overwrite unsaved edits.
Overview
Documents the editor version history feature across English, Spanish, French, and Chinese
editor/pages.mdxguides.Adds a Version history section (after diff view in EN/ES/FR; after Markdown mode in ZH) covering how to open it via More options → Version history, what each saved entry shows (author, relative time, Latest), scope (public pages use the current branch; private pages share history across branches), Show more versions pagination, the
docs.jsonexclusion, and the restore workflow for older versions.Users with permission to edit a page can select Restore on an older version and confirm the action. Restore replaces the current page content, including unsaved changes. Viewers can review and compare saved versions of private pages. Editors and managers can restore them. Restore is unavailable on blocked deploy branches and the Latest version. Users can compare versions from the drawer and select the active version again to exit comparison.
Frontmatter keywords now include version history; the Chinese page also gets a focused description covering version history alongside other page-editing topics.
Reviewed by Cursor Bugbot for commit 82db3dc. Bugbot is set up for automated code reviews on this repo. Configure here.
Update history
Note
Low Risk
Documentation-only MDX updates with no runtime or security impact; they describe a destructive restore workflow for readers.
Overview
Adds Version history documentation to the editor pages guides in English, Spanish, French, and Chinese, placed after diff view (EN/ES/FR) or after Markdown mode (ZH).
The new section explains how saved versions are recorded (new entry only when content differs; no duplicate on unchanged saves; empty pages allowed), how entries are grouped and labeled (Current), and that
docs.jsonis excluded. It documents opening history via More options → Version history and the Edited timestamp when supported.It clarifies scope: public page history is limited to the current branch; private page history spans all branches, with Show more versions for older entries. Restore is available on older versions for users with edit permission (editors/managers on private pages); it replaces current content including unsaved changes, with different behavior for public vs private pages. Restore is unavailable on blocked deploy branches and the Current entry. Selecting a row opens diff view against the current page; clicking the active row again exits comparison.
Frontmatter keywords now include version history; the Chinese page also gets an expanded description covering version history alongside other editing topics.
Reviewed by Cursor Bugbot for commit 8024f71. Bugbot is set up for automated code reviews on this repo. Configure here.